<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>BSONSerializeOptions | mongodb</title>
	<meta name="description" content="Documentation for mongodb">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
	<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">mongodb</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../modules.html">mongodb</a>
				</li>
				<li>
					<a href="bsonserializeoptions.html">BSONSerializeOptions</a>
				</li>
			</ul>
			<h1>Interface BSONSerializeOptions</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-comment">
				<div class="tsd-comment tsd-typography">
					<div class="lead">
						<p>BSON Serialization options.</p>
					</div>
				</div>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SerializeOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;index&quot;</span><span class="tsd-signature-symbol">&gt;</span>
					</li>
					<li>
						<span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">DeserializeOptions</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">&quot;evalFunctions&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cacheFunctions&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;cacheFunctionsCrc32&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;allowObjectSmallerThanBufferSize&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;index&quot;</span><span class="tsd-signature-symbol">&gt;</span>
						<ul class="tsd-hierarchy">
							<li>
								<span class="target">BSONSerializeOptions</span>
								<ul class="tsd-hierarchy">
									<li>
										<a href="commandoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CommandOptions</a>
									</li>
									<li>
										<a href="queryoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">QueryOptions</a>
									</li>
									<li>
										<a href="operationdescription.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationDescription</a>
									</li>
									<li>
										<a href="collectionoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">CollectionOptions</a>
									</li>
									<li>
										<a href="abstractcursoroptions.html" class="tsd-signature-type" data-tsd-kind="Interface">AbstractCursorOptions</a>
									</li>
									<li>
										<a href="dboptions.html" class="tsd-signature-type" data-tsd-kind="Interface">DbOptions</a>
									</li>
									<li>
										<a href="mongoclientoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">MongoClientOptions</a>
									</li>
									<li>
										<a href="operationoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">OperationOptions</a>
									</li>
									<li>
										<a href="topologyoptions.html" class="tsd-signature-type" data-tsd-kind="Interface">TopologyOptions</a>
									</li>
								</ul>
							</li>
						</ul>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#bsonregexp" class="tsd-kind-icon">bson<wbr>Reg<wbr>Exp</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#checkkeys" class="tsd-kind-icon">check<wbr>Keys</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#fieldsasraw" class="tsd-kind-icon">fields<wbr>AsRaw</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#ignoreundefined" class="tsd-kind-icon">ignore<wbr>Undefined</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#promotebuffers" class="tsd-kind-icon">promote<wbr>Buffers</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#promotelongs" class="tsd-kind-icon">promote<wbr>Longs</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#promotevalues" class="tsd-kind-icon">promote<wbr>Values</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="bsonserializeoptions.html#raw" class="tsd-kind-icon">raw</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external"><a href="bsonserializeoptions.html#serializefunctions" class="tsd-kind-icon">serialize<wbr>Functions</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="bsonregexp" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> bson<wbr>Reg<wbr>Exp</h3>
					<div class="tsd-signature tsd-kind-icon">bson<wbr>Reg<wbr>Exp<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.bsonRegExp</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:314</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>return BSON regular expressions as BSONRegExp instances.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="checkkeys" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> check<wbr>Keys</h3>
					<div class="tsd-signature tsd-kind-icon">check<wbr>Keys<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.checkKeys</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:920</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>the serializer will check if keys are valid.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="fieldsasraw" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> fields<wbr>AsRaw</h3>
					<div class="tsd-signature tsd-kind-icon">fields<wbr>AsRaw<span class="tsd-signature-symbol">:</span> <a href="document.html" class="tsd-signature-type" data-tsd-kind="Interface">Document</a></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.fieldsAsRaw</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:312</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>allow to specify if there what fields we wish to return as unserialized raw buffer.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="ignoreundefined" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> ignore<wbr>Undefined</h3>
					<div class="tsd-signature tsd-kind-icon">ignore<wbr>Undefined<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.ignoreUndefined</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:924</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>serialize will not emit undefined fields <strong>(default:true)</strong></p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="promotebuffers" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr>Buffers</h3>
					<div class="tsd-signature tsd-kind-icon">promote<wbr>Buffers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.promoteBuffers</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:308</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>when deserializing a Binary will return it as a node.js Buffer instance.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="promotelongs" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr>Longs</h3>
					<div class="tsd-signature tsd-kind-icon">promote<wbr>Longs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.promoteLongs</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:306</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>when deserializing a Long will fit it into a Number if it&#39;s smaller than 53 bits</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="promotevalues" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> promote<wbr>Values</h3>
					<div class="tsd-signature tsd-kind-icon">promote<wbr>Values<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.promoteValues</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:310</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>when deserializing will promote BSON values to their Node.js closest equivalent types.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
					<a name="raw" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> raw</h3>
					<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Overrides Omit.raw</p>
						<ul>
							<li>Defined in <a href="https://github.com/mongodb/node-mongodb-native/blob/b67af3cd/src/bson.ts#L55">src/bson.ts:55</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>Return BSON filled buffers from operations</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
					<a name="serializefunctions" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagOptional">Optional</span> serialize<wbr>Functions</h3>
					<div class="tsd-signature tsd-kind-icon">serialize<wbr>Functions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
					<aside class="tsd-sources">
						<p>Inherited from Omit.serializeFunctions</p>
						<ul>
							<li>Defined in node_modules/bson/bson.d.ts:922</li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>serialize the javascript functions <strong>(default:false)</strong>.</p>
						</div>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class=" ">
						<a href="../modules.html">Exports</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface">
						<a href="bsonserializeoptions.html" class="tsd-kind-icon">BSONSerialize<wbr>Options</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#bsonregexp" class="tsd-kind-icon">bson<wbr>Reg<wbr>Exp</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#checkkeys" class="tsd-kind-icon">check<wbr>Keys</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#fieldsasraw" class="tsd-kind-icon">fields<wbr>AsRaw</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#ignoreundefined" class="tsd-kind-icon">ignore<wbr>Undefined</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#promotebuffers" class="tsd-kind-icon">promote<wbr>Buffers</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#promotelongs" class="tsd-kind-icon">promote<wbr>Longs</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#promotevalues" class="tsd-kind-icon">promote<wbr>Values</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
								<a href="bsonserializeoptions.html#raw" class="tsd-kind-icon">raw</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited tsd-is-external">
								<a href="bsonserializeoptions.html#serializefunctions" class="tsd-kind-icon">serialize<wbr>Functions</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>